home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 4 / Meeting Pearls Vol. IV (1996)(GTI - Schatztruhe)[!].iso / Pearls / libs / bgui / Docs / progressclass.doc < prev    next >
Text File  |  1995-04-23  |  2KB  |  81 lines
  1.  
  2.                File: progressclass.doc
  3.         Description: Progressclass documentation.
  4.           Copyright: (C) Copyright 1994-1995 Jaba Development.
  5.                      (C) Copyright 1994-1995 Jan van den Baard.
  6.                      All Rights Reserved.
  7.  
  8. ------------------------------------------------------------------------------
  9.  
  10. TABLE OF CONTENTS
  11.  
  12. progressclass/--background--
  13. progressclass/Methods
  14. progressclass/Attributes
  15.  
  16. progressclass/--background--                      progressclass/--background--
  17.  
  18.     NAME
  19.         Class:          progressclass
  20.         Superclass:     baseclass
  21.         Include File:   <libraries/bgui.h>
  22.  
  23.     FUNCTION
  24.         To  provide  a  progression  indicator  in  the  form of a fuel guage.
  25.         Objects from this class will send out the following attribute pairs in
  26.         notification events:
  27.  
  28.         GA_ID           - Gadget object ID.
  29.         PROGRESS_Done   - Current level of progression.
  30.  
  31. progressclass/Methods                                    progressclass/Methods
  32.  
  33.     NEW METHODS
  34.         None.
  35.  
  36.     CHANGED METHODS
  37.         None.
  38.  
  39. progressclass/Attributes                              progressclass/Attributes
  40.  
  41.     NAME
  42.         PROGRESS_Min, PROGRESS_Max - ( LONG )
  43.  
  44.     FUNCTION
  45.         Set the minimum and maximum possible progression.
  46.  
  47.         Defaults are 0 minimum and 100 maximum. Applicability is (IS).
  48.  
  49.     SEE ALSO
  50.         PROGRESS_Done
  51.  
  52.     NAME
  53.         PROGRESS_Done -- ( LONG )
  54.  
  55.     FUNCTION
  56.         Set or update the current level of progression.
  57.  
  58.         Default is 0. Applicability is (ISGNU).
  59.  
  60.     SEE ALSO
  61.         PROGRESS_Min, PROGRESS_Max
  62.  
  63.     NAME
  64.         PROGRESS_Vertical -- ( BOOL )
  65.  
  66.     FUNCTION
  67.         To  make  the  indication vertical. By default the guage is horizontal
  68.         which  is  filled  from left to right. A vertical guage is filled from
  69.         bottom to top.
  70.  
  71.         Default is FALSE. Applicability is (I).
  72.  
  73.     NAME
  74.         PROGRESS_Divisor -- ( ULONG )
  75.  
  76.     FUNCTION
  77.         Set  a divisor which is used to devide the level of progression before
  78.         it  is  rendered.  This  is necessary when the progression minimum and
  79.         maximum levels are very far appart (I.E. 0 to 0xFFFFFFFF).  This way a
  80.         fairly accurate progression is displayed.
  81.